home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 2.iso / STUTTGART / FROMUTS / PACKDIR / !PackDir / Docs / Guide next >
Text File  |  1991-10-20  |  11KB  |  257 lines
  1. >Guide
  2. _______________________________________________________________________________
  3.  
  4. PackDir 1.17                                   -------------------------------
  5.                                                 This program is PUBLIC DOMAIN
  6. Version date : 20 Oct 1991                     -------------------------------
  7.  
  8. ----------------
  9. - Introduction -
  10. ----------------
  11. PackDir will archive an entire directory, including all its subdirectories,
  12. into a very compact archive file. Directories in archives may be completely
  13. restored at either their original path or a new path.
  14.  
  15. PackDir uses LZW compression (also widely used in most present day archivers)
  16. to substantially reduce the archive's size. It uses highly optimized ARM code
  17. compression and decompression routines, making it *very* fast, which was
  18. necessary to make it a viable alternative to the (excellent, but very slow)
  19. !Spark (de)archiving application by David Pilling.
  20.  
  21. I wrote PackDir only to facilitate really fast and compact backup, for hard
  22. discs and the like. PackDir is not meant to be an alternative to Spark in any
  23. other way, as the archives made by PackDir have an incompatible format.
  24.  
  25. Speed ?
  26.  
  27. PackDir archives around 3 times as fast as !Spark, and unpacks about 3.5 times
  28. as fast, resulting in about the same size archives (0.5% smaller). (!Spark was
  29. set to 13-bit 'Compress', !PackDir to 13-bit, no background mode. Testing was
  30. in mode 0).
  31.  
  32.  
  33. -------------------------
  34. - Using the application -
  35. -------------------------
  36. To start up PackDir, either :
  37.  
  38. - Double-click on the '!PackDir' icon.
  39. - Double-click on a PackDir archive file, after !PackDir has been seen by the
  40.   filer.
  41.  
  42. It will install itself on the icon bar, and clicking MENU on PackDir's icon
  43. will pop up the main menu (refer to its discussion below).
  44.  
  45. Archiving a directory
  46. ---------------------
  47. To archive a directory, simply drag it onto PackDir's iconbar icon. A save
  48. window will appear. Dragging the archive icon to a directory viewer will start
  49. the archiving process.
  50.  
  51. By default, the leafname of the archive file is set to the directory's
  52. leafname. You may change this by entering another leafname into the writable
  53. icon below the archive icon.
  54.  
  55. NOTE : Pressing CTRL while dragging a directory to PackDir will archive the
  56. parent of the directory. This is to enable archiving of the root directory ($)
  57. of a disc. The default leafname will be 'Root', as '$' is an illegal filename.
  58.  
  59. Unpacking an archive
  60. --------------------
  61. To unpack an archive, drag it onto PackDir's iconbar icon, or double-click on
  62. it. A save window will appear. Dragging the directory icon to a directory
  63. viewer will start the unpacking process.
  64.  
  65. By default, the leafname of the directory is set to the archive's leafname.
  66. You may change this by entering another leafname into the writable icon below
  67. the directory icon.
  68.  
  69. Unpacking may also be to the original path (including filing system), which has
  70. been stored in the archive (see the 'Old path' option). In this case, no save
  71. window will appear, and unpacking starts immediately.
  72.  
  73. The information window
  74. ----------------------
  75. Clicking on the iconbar icon with either SELECT or ADJUST will pop up a report
  76. window, in which continuous information is given about the actions performed
  77. during (de)archiving.
  78.  
  79. 'Old path' indicates the full original path up to and including the directory
  80. to be archived or being unpacked. 'New path', when unpacking, shows the full
  81. path of the directory being recreated (i.e. the old path when the 'Old path'
  82. option is on).
  83.  
  84. Also shown are :
  85.  
  86. - The 'local' filename of the current file or directory being (un)archived
  87. - The length of the last (archiving) or current (unpacking) file or directory
  88. - The number of compression bits (being) used
  89. - The compression ratio achieved on the last (archiving) or current (unpacking)
  90.   file or directory
  91. - The total file data compression ratio so far (archiving), or the total ratio
  92.   (unpacking, shown only at the end)
  93. - A count of items (files and directories) (un)archived so far (including the
  94.   top directory itself)
  95. - A red bar representing an amount of original file data processed so far, with
  96.   behind it an amount in bytes.
  97.   When archiving, a full bar represents the total amount of original file data.
  98.   The beige part of the bar represents the size of the current file being
  99.   archived. The amount shows the total amount of original file data in bytes,
  100.   and is not updated.
  101.   When unpacking, the bar is not updated. The amount shows the total amount of
  102.   original file data unpacked so far.
  103. - A green bar representing an amount of archived file data processed so far,
  104.   with behind it an amount in bytes.
  105.   When archiving, a full bar represents the total amount of original file data.
  106.   If viewed together with the red bar, the relative sizes of the archived file
  107.   data and the original file data, processed so far, may be observed. The
  108.   amount shows the total amount of archived file data accumulated so far.
  109.   When unpacking, a full bar represents the total archive file size. The beige
  110.   part shows the size of the part of the archive that is currently being
  111.   processed. The amount shows the total amount of archived file data processed
  112.   so far.
  113.  
  114.  
  115. -----------------
  116. - The main menu -
  117. -----------------
  118. Clicking MENU on the iconbar icon will pop up the main menu. The 'Quit' and
  119. 'Info' icons have their usual effect.
  120.  
  121. The main purpose of the main menu is to provide access to PackDir's control
  122. window. The 'Control' icon in the main menu gives access to this control window
  123. in two ways :
  124.  
  125. a) Following its submenu arrow, a non-permanent control window is popped up.
  126.    This disappears automatically, subject roughly to normal submenu behaviour.
  127. b) Clicking on it pops up a permanent control window. This only disappears
  128.    after clicking on its close icon.
  129.  
  130. Several types of icons appear in the control window :
  131.  
  132. - Toggle icons. These are square, and clicking on them switches the
  133.   corresponding option on (red square in its middle) or off ('closed' box).
  134. - Radio icon sets. Icons in these sets are diamond shaped, and act like the
  135.   toggle icons, but only one of them may be on. Switching any one on will
  136.   switch off all the others in the same set (hence the name 'radio' icons).
  137.  
  138. The functions of the main menu icons and the icons in the control window are
  139. discussed below. Icons are named by giving their menu 'path', submenu arrows
  140. being indicated by '|'. Sometimes the text above a set of icons (usually radio
  141. icons) is indicated as being a 'submenu' in itself.
  142.  
  143. -----------
  144. | Control |
  145. -----------
  146. This icon gives access to the control window.
  147.  
  148. -------------------------
  149. | Control | Compression |
  150. -------------------------
  151. This set of radio icons enables you to select the maximum number of bits used
  152. in LZW compression when archiving a directory.
  153.  
  154. There is a choice of 12, 13, 14, 15 and 16 bits. More bits usually results in
  155. better compression. This is especially true on large text files.
  156.  
  157. The disadvantage of using more bits is that it also requires more memory to
  158. archive/unpack. In general, for compression (archiving) 12*2^bits and for
  159. decompression (unpacking) 9*2^bits bytes, i.e. from 48/36K for 12-bit up to
  160. 786/576K for 16-bit.
  161.  
  162. When memory allows, choose the lowest number of bits that yields the highest
  163. compression ratio. Experimentation is the key here.
  164.  
  165. -------------------
  166. | Control | Store |
  167. -------------------
  168. This set of radio icons determines what is stored in new archive(s).
  169.  
  170. When 'All' is selected, everything is stored, which is the normal situation.
  171.  
  172. When 'Skeleton' is selected, everything is stored, except file's contents. This
  173. setting may be useful, for example, to compactly store away a directory's
  174. structure only, when the actual file data is irrelevant. E.g. when you need to
  175. show someone (via a modem) what's in the directory, but, obviously, don't want
  176. to transmit all the data with it. Obviously, these archives will be very small,
  177. and will be created very quickly.
  178.  
  179. ----------------------
  180. | Control | Recreate |
  181. ----------------------
  182. This set of radio icons enables you to select what will be recreated from an
  183. archive.
  184.  
  185. When 'All' is selected, everything that's in the archive is recreated, which is
  186. the normal situation. Archives that were saved as skeletons will unpack like
  187. 'Envelope' (see below).
  188.  
  189. When 'Envelope' is selected, everything is recreated, except file's contents.
  190. Files will have the correct length, but will contain 'junk'. The space taken
  191. will be exactly the original amount. This setting may be useful, for example,
  192. to have a quick look at how much room the unpacked directory will require.
  193.  
  194. When 'Skeleton' is selected, everything is recreated, except file's contents,
  195. and all file's lengths are set to zero. This setting may be useful, for
  196. example, to have a quick look at an archive's contents (file dates, filetypes,
  197. etc.), sacrificing a minimal amount of temporary disc space.
  198.  
  199. -----------------------
  200. | Control | Unpack to |
  201. -----------------------
  202. This set of radio icons chooses the path to which an archive is unpacked.
  203.  
  204. When 'Old path' is selected, then unpacking an archive is to the original
  205. filing system and directory path (which has been stored within the archive).
  206.  
  207. When 'New path' is selected, unpacking is to a different directory than the
  208. original one. The destination directory is the directory of the filer window
  209. that the directory icon was dragged to.
  210.  
  211.  
  212. -----------------------
  213. - Memory requirements -
  214. -----------------------
  215. !PackDir runs in a minimum amount of memory when dormant. Prior to archiving
  216. or unpacking, all available memory is grabbed, and released again on
  217. completion of the operation.
  218.  
  219. NOTE : The amount of extra memory needed (i.e. the amount you must keep free)
  220. varies, depending on the number of bits compression. Extra memory on top of
  221. that needed for (de)compression tables will be used for file buffering, thus
  222. speeding up processing.
  223.  
  224.  
  225. -----------
  226. - The end -
  227. -----------
  228. If you have praise, complaints, comments, bugs(!), or anything else to offer
  229. me, do not hesitate to write to
  230.  
  231. John Kortink
  232. Middelhuisstr. 17
  233. 7482 EL Haaksbergen
  234. The Netherlands
  235.  
  236. or send email to kortink@cs.utwente.nl
  237.  
  238. New versions of the application are available from the same address : just send
  239. £1 to cover postage and a self-addressed envelope containing a 3.5" disc.
  240.  
  241. It is not very likely though that many new versions will appear. !PackDir
  242. serves a simple purpose, and does it well, and this will remain to be so.
  243.  
  244. Happy archiving !!!
  245.  
  246. _______________________________________________________________________________
  247.  
  248. !!! NOTE !!!
  249.  
  250. You may NOT change this application or use ANY part of it in other products
  251. without my approval. You may spread it freely (with *ALL* files included), but
  252. not for any profit. This software is provided 'as is'. Using it is entirely at
  253. your own risk.
  254.  
  255. _______________________________________________________________________________
  256.  
  257.